<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: cy_stc_crypto_config_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('structcy__stc__crypto__config__t.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">cy_stc_crypto_config_t Struct Reference<div class="ingroups"><a class="el" href="group__group__crypto.html">Crypto       (Cryptography)</a> &raquo; <a class="el" href="group__group__crypto__cli__srv.html">Client-Server Model</a> &raquo; <a class="el" href="group__group__crypto__cli__srv__data__structures.html">Data Structures</a> &raquo; <a class="el" href="group__group__crypto__config__structure.html">Common Data Structures</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<div class="textblock"><p>The Crypto configuration structure. </p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:abef76d6d8c3b14def789a9700ba9389d"><td class="memItemLeft" align="right" valign="top"><a id="abef76d6d8c3b14def789a9700ba9389d"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__crypto__config__t.html#abef76d6d8c3b14def789a9700ba9389d">ipcChannel</a></td></tr>
<tr class="memdesc:abef76d6d8c3b14def789a9700ba9389d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines the IPC channel used for client-server data exchange. <br /></td></tr>
<tr class="separator:abef76d6d8c3b14def789a9700ba9389d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abaea23dcf6f3e7c467646f73b2f9772d"><td class="memItemLeft" align="right" valign="top"><a id="abaea23dcf6f3e7c467646f73b2f9772d"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__crypto__config__t.html#abaea23dcf6f3e7c467646f73b2f9772d">acquireNotifierChannel</a></td></tr>
<tr class="memdesc:abaea23dcf6f3e7c467646f73b2f9772d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the IPC notifier channel (IPC interrupt structure number) to notify server that data for the operation is prepared. <br /></td></tr>
<tr class="separator:abaea23dcf6f3e7c467646f73b2f9772d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac0565f33722a6688fa31e0fc134ac0bd"><td class="memItemLeft" align="right" valign="top"><a id="ac0565f33722a6688fa31e0fc134ac0bd"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__crypto__config__t.html#ac0565f33722a6688fa31e0fc134ac0bd">releaseNotifierChannel</a></td></tr>
<tr class="memdesc:ac0565f33722a6688fa31e0fc134ac0bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the IPC notifier channel (IPC interrupt structure number) to notify client that operation is complete and data is valid. <br /></td></tr>
<tr class="separator:ac0565f33722a6688fa31e0fc134ac0bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0c85bc368f569f5ded79957fb32b7a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcy__stc__sysint__t.html">cy_stc_sysint_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__crypto__config__t.html#ab0c85bc368f569f5ded79957fb32b7a8">releaseNotifierConfig</a></td></tr>
<tr class="memdesc:ab0c85bc368f569f5ded79957fb32b7a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the release notifier interrupt configuration.  <a href="#ab0c85bc368f569f5ded79957fb32b7a8">More...</a><br /></td></tr>
<tr class="separator:ab0c85bc368f569f5ded79957fb32b7a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52ff77b99e58e9f238f260a50740be7b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__crypto__config__structure.html#ga007ebc02b80ed1e6beacc6cb749a2941">cy_crypto_callback_ptr_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__crypto__config__t.html#a52ff77b99e58e9f238f260a50740be7b">userCompleteCallback</a></td></tr>
<tr class="memdesc:a52ff77b99e58e9f238f260a50740be7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">User callback function.  <a href="#a52ff77b99e58e9f238f260a50740be7b">More...</a><br /></td></tr>
<tr class="separator:a52ff77b99e58e9f238f260a50740be7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4130639046fb3a253bf8898f5dc23f7b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__syslib__macros.html#ga71c09beda7671d1f69c8f06a546e2ae6">cy_israddress</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__crypto__config__t.html#a4130639046fb3a253bf8898f5dc23f7b">userGetDataHandler</a></td></tr>
<tr class="memdesc:a4130639046fb3a253bf8898f5dc23f7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Server-side user IRQ handler function, called when data for the operation is prepared to process.  <a href="#a4130639046fb3a253bf8898f5dc23f7b">More...</a><br /></td></tr>
<tr class="separator:a4130639046fb3a253bf8898f5dc23f7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0edc56bcfa1323e9fbf2421afbec9f72"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__syslib__macros.html#ga71c09beda7671d1f69c8f06a546e2ae6">cy_israddress</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__crypto__config__t.html#a0edc56bcfa1323e9fbf2421afbec9f72">userErrorHandler</a></td></tr>
<tr class="memdesc:a0edc56bcfa1323e9fbf2421afbec9f72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Server-side user IRQ handler function, called when a Crypto hardware error occurs (interrupt was raised).  <a href="#a0edc56bcfa1323e9fbf2421afbec9f72">More...</a><br /></td></tr>
<tr class="separator:a0edc56bcfa1323e9fbf2421afbec9f72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd4789ed2371b4b38395295401248b34"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcy__stc__sysint__t.html">cy_stc_sysint_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__crypto__config__t.html#abd4789ed2371b4b38395295401248b34">acquireNotifierConfig</a></td></tr>
<tr class="memdesc:abd4789ed2371b4b38395295401248b34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the prepared data notifier interrupt configuration.  <a href="#abd4789ed2371b4b38395295401248b34">More...</a><br /></td></tr>
<tr class="separator:abd4789ed2371b4b38395295401248b34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41313f24ce9075f5262938072669fea4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcy__stc__sysint__t.html">cy_stc_sysint_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__crypto__config__t.html#a41313f24ce9075f5262938072669fea4">cryptoErrorIntrConfig</a></td></tr>
<tr class="memdesc:a41313f24ce9075f5262938072669fea4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the hardware error processing interrupt configuration.  <a href="#a41313f24ce9075f5262938072669fea4">More...</a><br /></td></tr>
<tr class="separator:a41313f24ce9075f5262938072669fea4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a id="ab0c85bc368f569f5ded79957fb32b7a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0c85bc368f569f5ded79957fb32b7a8">&#9670;&nbsp;</a></span>releaseNotifierConfig</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structcy__stc__sysint__t.html">cy_stc_sysint_t</a> cy_stc_crypto_config_t::releaseNotifierConfig</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Specifies the release notifier interrupt configuration. </p>
<p>It used for internal purposes and user doesn't fill it. </p>

</div>
</div>
<a id="a52ff77b99e58e9f238f260a50740be7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52ff77b99e58e9f238f260a50740be7b">&#9670;&nbsp;</a></span>userCompleteCallback</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__crypto__config__structure.html#ga007ebc02b80ed1e6beacc6cb749a2941">cy_crypto_callback_ptr_t</a> cy_stc_crypto_config_t::userCompleteCallback</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>User callback function. </p>
<p>If this field is NOT NULL, it called when Crypto operation is complete. </p>

</div>
</div>
<a id="a4130639046fb3a253bf8898f5dc23f7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4130639046fb3a253bf8898f5dc23f7b">&#9670;&nbsp;</a></span>userGetDataHandler</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__syslib__macros.html#ga71c09beda7671d1f69c8f06a546e2ae6">cy_israddress</a> cy_stc_crypto_config_t::userGetDataHandler</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Server-side user IRQ handler function, called when data for the operation is prepared to process. </p>
<ul>
<li>If this field is NULL, server will use own interrupt handler to get data.</li>
<li><p class="startli">If this field is not NULL, server will call this interrupt handler. This interrupt handler must call the <a class="el" href="group__group__crypto__srv__functions.html#ga247aad529a2ad367f757c4b2aa1995da">Cy_Crypto_Server_GetDataHandler</a> to get data to process.</p>
<p class="startli">Note: In the second case user should process data separately and clear interrupt by calling <a class="el" href="group__group__crypto__srv__functions.html#gab3a5d2a4bd48f96e41d47117aabdfef6">Cy_Crypto_Server_Process</a>. This model is used in the multitasking environment. </p>
</li>
</ul>

</div>
</div>
<a id="a0edc56bcfa1323e9fbf2421afbec9f72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0edc56bcfa1323e9fbf2421afbec9f72">&#9670;&nbsp;</a></span>userErrorHandler</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__syslib__macros.html#ga71c09beda7671d1f69c8f06a546e2ae6">cy_israddress</a> cy_stc_crypto_config_t::userErrorHandler</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Server-side user IRQ handler function, called when a Crypto hardware error occurs (interrupt was raised). </p>
<ul>
<li>If this field is NULL - server will use own interrupt handler for error processing.</li>
<li>If this field is not NULL - server will call this interrupt handler. This interrupt handler must call the <a class="el" href="group__group__crypto__srv__functions.html#ga36706e765604590078a2a55c6355b897">Cy_Crypto_Server_ErrorHandler</a> to clear the interrupt. </li>
</ul>

</div>
</div>
<a id="abd4789ed2371b4b38395295401248b34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd4789ed2371b4b38395295401248b34">&#9670;&nbsp;</a></span>acquireNotifierConfig</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structcy__stc__sysint__t.html">cy_stc_sysint_t</a> cy_stc_crypto_config_t::acquireNotifierConfig</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Specifies the prepared data notifier interrupt configuration. </p>
<p>It used for internal purposes and user doesn't fill it. </p>

</div>
</div>
<a id="a41313f24ce9075f5262938072669fea4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41313f24ce9075f5262938072669fea4">&#9670;&nbsp;</a></span>cryptoErrorIntrConfig</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structcy__stc__sysint__t.html">cy_stc_sysint_t</a> cy_stc_crypto_config_t::cryptoErrorIntrConfig</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Specifies the hardware error processing interrupt configuration. </p>
<p>It used for internal purposes and user doesn't fill it. </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
